<<< Anywhere I mention "Red Ryder Host" also applies to "Second Sight Host". Other BBS >>>
<<< programs might also be applicable, but I am not completely sure. >>>
***** PLEASE READ THE FOLLOWING VERY CAREFULLY! *****
THIS UTILITY TAKES UP THE NETWORK MAIL APPLICATION SLOT. If you still wish to have your Network Mail Application running like it was before, then just set the "BBS Application" to your Network Mail Application. This should not affect anything else.
Make sure that you put "NightOnline" into your BBS directory (the directory that has your BBS application). Also, if you have moved the NOConfig file anywhere since it was first installed, make sure that it is still in the same folder as NightOnline, in order for it to work properly. Make sure that you have NightOnline in the same folder as your BBS application. If not, then you might run into problems with the BBS's configuration file. PLEASE NOTE: THIS VERSION SUPPORTS HFS ORGANIZATION OF YOUR BBS FILES.
SETTING UP NIGHTONLINE:
Setting up is not very difficult. Just double-click on NightOnline, and wait for the "Loading Configuration" to disappear. Then, fill out all of the options in the "Main" menu. Fill out the other options as you wish. Finally, select, 'Quit to finder'. From then on, don't worry about NightOnline.
SETTING UP YOUR BBS TO USE NIGHTONLINE:
The easiest way to use NightOnline is to set it up, and make menu items on your BBS that read the several text files that NightOnline creates or modifies.
APPLE MENU:
About NightOnline...
Displays about box for NightOnline.
FILE MENU:
Save Config
Saves current setup (configuration).
Load Config
Loads last-saved setup (configuration). Useful if you wish to revert your changes.
Quit to Finder
Automatically saves your setup (configuration) and exits to the Finder.
Select this option after you have finished configuring NightOnline.
Quit to BBS/NetMail
Automatically saves your setup (configuration) and exits to the application that you pre-set
in the NetMail Application dialog box in ConfigEdit. Select this option after you have finished
re-configuring NO and you want to return back to your BBS.
Quit to finder without saving
Only use this if you can't seem to find your Userlog, Callerlog or BBS file.
MAIN MENU:
BBS Name...
Changes the name of your BBS that will appear on the header of the cleared callerlog file.
Locate Userlog file...
Changes the location of the Userlog file. This option MUST be selected.
Locate Callerlog file...
Changes the location of the Callerlog file. This option MUST be selected.
Locate BBS/NetMail Application...
Changes the location of the BBS file or the NetMail application. This option MUST be selected.
Change NightOnline folder...
Allows you to select the folder that will contain all of the files created by NightOnline.
CALLERLOG MENU:
Clear Daily
When checked, the callerlog will only be cleared.
Clear Daily & Backup Day
When checked, the callerlog will be cleared and also a separate time-stamped file will be
created as a copy of that day's callerlog file.
Clear Daily & Main Backup
When checked, the callerlog will be cleared and also that day's callerlog file will be appended
to a large main backup callerlog file.
Change Main Backup name...
Will be active if "Clear Daily & Main Backup" is checked. Lets you change the name of the file
to whatever you desire.
Print Callerlog Each Day
When checked, the callerlog will be printed to an ImageWriter printer each day.
Don't Print Callerlog
When checked, the callerlog won't be printed each day.
TRASHCAN MENU:
Name of Trashcan file...
Lets you change the name of the text file that contains up to 20 search keys for the Trashcan
feature. If the Trashcan file is blank, then the Trashcan feature is ignored.
Name of Exceptions file...
Lets you change the name of the text file that contains up to 20 full names of Users that match
the search data, but shouldn't be marked for deletion and trashed.
Name of Trashed Users file...
Lets you change the name of the text file that contains the list of the users that were trashed.
Each night, the name of the users is appended to this list.
Password for Trashed Users...
Lets you change the password that the users that are trashed will end up with.
STATS MENU:
Name of Previous Stats...
Chagnes the name of the Previous Stats file that contains the statistics of the previous day.
Uses data found in Callerlog file, so best results can be obtained if all Callerlog options in
ConfigEdit are chosen.
Callers' Names
If checked, then only the list of the callers of the previous day will be listed in the Previous
Stats file.
Callers' Names & Statistics
If checked, both the list of the callers of the previous day will be listed in the Previous Stats
file, as well as the statistics including the number of calls, messages, etc.
UU MENU: (User Utilities)
Number of Top Uploaders...
Lets you change the number of Top Uploaders that will be compiled into the Top Uploaders list.
Change DL/UL Leech Ratio...
Lets you change the number of downloads one can have for every upload. If a user exceeds that
amount, then they will be appended to the Leech list.
Change Leech Extra Number...
Lets you change the number of downloads that the user can have before the Leech ratio is taken
into affect.
Name of Top Uploaders list...
Lets you change the name of the Top Uploaders list that is compiled daily. This list is
self-explanatory.
Name of Leech list...
Lets you change the name of the Leech list that is compiled daily. This list is useful if you
want to keep track of users that are downloading too much.
Name of User Stats list...
Lets you change the name of the User Stats list that is compiled daily. This list is composed of
all of the users along with their number of calls, uploads, downloads, etc.
Name of User Percent list...
Lets you change the name of the User Percent list that is compiled daily. This list is composed
of the percentage of the total number of calls, uploads, downloads, etc. per each person.
Accurate to a tenth of a percent, rounded down.
Name of Top Statistics file..
Lets you change the name of the Top Statistics file that is compiled daily.
Misc Menu:
Global list of files (# Days)...
Lets you select the number of days that you want the global new file search to be as of. It is
best that you set this option to a number like 7 days, as that decreases the length of time that
NO takes to compile the sorting and also decreases the length of the list. There is no limit to
the number of days, however.
Global list of files (Sections)...
Lets you select the file sections that you wish to be added to the global new files list. The list
of most frequently DL'd software also uses these same file sections. To conserve time, it is
best to limit the number of file sections in this option. The maximum is 16. This feature is
the most time-consuming feature of NO, so keep time in mind.
Global list of files (Name)...
Lets you select the name that you wish the list of the files uploaded within the last x days. You
set the number of days with the option, "Global list of files (# Days)...".
Frequently DL'd software name...
Lets you select the name of the text file that contains a list of the most downloaded programs
that you have, in the file sections that you have set in the option, "Global list of files
(Sections)...".
Number of files to list...
Lets you select the number of files that will be organized in the list of Frequently DL'd
programs by order of number of downloads.
Backup Userlog
Toggles (with a checkmark) whether the Userlog file is to be backed up daily or not. If
checked, then it will, otherwise it won't.
Backup Userlog name...
Changes the name of the backup of the userlog. This backup file has all of the changes made
by the Trashcan feature, but should be only used if NO bombs and corrupts your Userlog file.
Corruption of your Userlog file CAN happen, but you need not worry. NO backs up your
Userlog before it gets to the stage where it re-writes the Userlog file. At this stage, if you
turn off your computer or disrupt it somehow, your Userlog file will probably be corrupted.
If this happens, just rename the file Userlog.BAK (or whatever you have designated it to be)
and that should be it. If, by chance it changed your backup Userlog file to a text file (which
is very unlikely, but could happen), then just change the Type to "ULOG" and the creator to
"ULED". MAKE SURE that your Backup Userlog name is different than your Userlog name.
Otherwise, you may end up with your Userlog file corrupted and you won't have any Backup
of your Userlog file.
Inactive Users...
This allows you to change the number of days that a user must call within or else be deleted.
This option enables you to rid your system of old users that haven't called within two months,
for example.
Error Log Name...
Allows you to change the name of the text file that contains all of the errors since this version
was implemented.
Dates Files name...
Allows you to select the location of the (optional) Date files.
Dates Files output...
Allows you to select the text file that will contain the output from the Date Files. This option
must be selected in order for the Dates Files option to work.
===NOTES ON SPECIFIC FEATURES===
TRASHCAN FEATURE:
Remember that the Host BBS automatically converts all users' names to uppercase. Therefore, you must enter in all of your search data and your exception names in Uppercase.
eg:
JOHN DOE
BEN DOVER
M <-- Make sure that you have a RETURN after the last line.
In this example, it will delete any user that has the name of any of the following:
JOHN DOE, SJOHN DOE, JOHN DOES, BEN DOVERN, MIKE CANE, MICHAEL SURGART, MARTY NG, etc.
As you can see, you are pretty safe if you enter in the full names, rather than single letters. In the example above, any person with the lettter M in their name will be deleted. Be careful with this. It is always suggested that you use search data with at least five characters. It is also suggested that you add vulgarities to your Trashcan file, therefore, any idiot that decides to write something like, "SYSOP IS A ????" gets nailed. If there just so happens that there is a couple users that fit your search data, but you don't want them to be deleted every day, then add their names to the ExceptionsFile. Finally, there is a Password option. After it has marked a user for deletion, it will change their password to read, "TRASHED!" or whatever you have typed in. Leaving it blank will not change their password. The reason why you would probably want to change their password is so that you know by looking at the Userlog file that they have been trashed because of their user name. Every user that is trashed has their names added to a TEXT file named, "TrashedUsers" or whatever you decide to name it. This will give you an idea of which users are being deleted and which ones should, etc. TO CHANGE THE TRASHCAN FILE OR THE EXCEPTIONS FILE, YOU SHOULD USE A SIMPLE TEXT EDITOR SUCH AS MOCKWRITE. REMEMBER THAT THE MAXIMUM NUMBER OF TRASHCAN SEARCH LINES IS 20 AND THE MAXIMUM NUMBER OF EXCEPTION NAMES IS 20.
BACKUP USERLOG:
Deletes all users that are marked for deletion, as if you were to select, "Backup Userlog..." from UserEdit. Also, it creates a backup file of the old Userlog file so that it makes it harder to lose users.
DATES FILES:
These, if optionally added to your system along with NightOnline, automatically compile a list of the day's events and birthdays. This list can be compiled to a text file such as one of your SYSTEMx.MSG.
GLOBAL LIST:
This list, if activated, will create a list of the newest files in all of the file sections that you preset. It also asks you for a handle (name) for each, so that NigthOnline will use the full name that you entered for that section, rather than the filename of the section, which usually would confuse the user that reads the global list.
CONFIGURING YOUR BBS TO WORK WITH NIGHTONLINE:
The next step is to configure your BBS application. If you are using Red Ryder Host, then just open up "ConfigEdit" and open your current "Config" file. Then, fill in the time that you wish the daily maintenance to be done at. The best time is midnight (0:00:00). After you have set the time that you wish the maintenance to be done at, make sure that you have the option, "NetMail Application" set, and fill in the pathname to NightOnline.
Save your changes in the "Config" file, and then load up your BBS. From now on, it is automatic, and you shouldn't have any further worries.
If you wish to re-configure "NightOnline" then you just have to go back and double-click on it again, and then re-enter the data. Since it will not be your first time running NightOnline, you will have to hold down the mouse button.
WHY USE THIS PROGRAM?
This program was written in order to automate the Callerlog maintenance. It takes advantage of the Network Mail Application feature of Red Ryder Host. Some BBS's are run remotely, and in order to see who called earlier that day, you usually have to scan through days of other calls. This program automatically clears it at midnight or whenever you set it. See section regarding the time settings later in this document.
REQUIREMENTS
- Using Red Ryder Host V2.0 or other program with configurable Time Application launching.
- Not using any Network Mail Application (if using Red Ryder Host).
- Have the "Callerlog to DISK" option on.
- If you wish the Statistics file to be as accurate as possible, you should set the following options on your Callerlog to disk: Messages posted, Uploads/Downloads, Text File Reads, etc.
STATISTICS OF NIGHTONLINE (Maximums):
Trashcan Search lines: 20
Exceptions lines: 20
Global new files: 50
Global days: Unlimited
Global File Sections: 16
Top Uploaders: Unlimited to number of Users
Leeches: Unlimited to number of Users
On-line time for
NightOnline's Maintenance: Variable. A small BBS, approx. 5 minutes.
End date until bug: Year 2000 <-- There is a bug in NO currently that will create
a couple problems for any feature that uses the
current date when the year 2000 comes. Don't
worry, I'll add a fix to it soon. Also, Red Ryder
Host, itself will have a bug regarding the century
change. This, I can't fix.
TIME SETTINGS (Specific to Red Ryder Host)
Run "ConfigEdit" and open the current Config file. Go to the option labelled, "Network Mail Application". Set it to ON, and set the time to the desired time that the callerlog will be cleared. Then save the Config settings and re-run Red Ryder Host.
FILES CREATED OR MODIFIED BY NIGHTONLINE
===Callerlog (mm/dd/yy):
A copy of the Callerlog for that day labelled in its filename (ie. 01/30/83).
===Callerlog:
An updated Callerlog file that is cleared every day.
===Error.LOG:
A list of the errors that have been created since you first installed version 1.2 of NightOnline. This file is put in the designated NightOnline folder.
===ExceptionsFile:
TEXT file containing the full names of the users that fit the search data, but shouldn't be deleted by the trashcan feature. This file is put in the designated NightOnline folder.
===Frequent.DL:
Compiled list of the top x most downloaded files in the preset file sections. This file is put in the designated NightOnline folder.
===Global:
Compiled list of the files in the designated file sections for the past # of days. The list is in order of date per each file section. This file is put in the designated NightOnline folder.
===Leech.LIST:
Compiled list of all of the users that have downloaded more than the allowed ratio of uploads to downloads. It is in order of the time at which each user first logged on to the system. This file is put in the designated NightOnline folder.
===MainCallerlog:
A list that is optionally created that contains a compilation of each day's callerlog.
===NOConfig:
Data file configuration. Do not tamper with, unless you know the format for the text file.
===PreviousStats:
List of the names of the people that called the previous day, and optionally along with statistics on the number of 1200 baud calls, local logons, private messages, etc. This file is put in the designated NightOnline folder.
===TopUploaders:
Compiled list of a pre-set number of uploaders in order of the number of uploads and also the time that they called to the system first. This file is put in the designated NightOnline folder.
===Trashcan:
TEXT file containing a list of all of the search keys for the bogus users. You must edit this file if you wish to change the Trashcan keywords. This file is put in the designated NightOnline folder.
===TrashedUsers:
List of the users that have been trashed ever since you installed NightOnline. This file is put in the designated NightOnline folder.
===Userlog:
An updated Userlog that has been processed each night by the trashcan feature. Please keep a backup of the Userlog file each day for a couple days to MAKE SURE that it is working correctly.
===Userlog.BAK:
A copy of the Userlog file.
===User.STATS:
Compiled list of all of the users on the BBS with most statistics including Uploads, Downloads, Private Messages, Public Messages, Calls and Date last on. This file is put in the designated NightOnline folder.
===User.Percent:
Compiled list of all of the users on the BBS with most statistics including Uploads, Downloads, Private Messages, Public Messages, Calls and Date last on as a percentage of all of the Uploads, Downloads, Private Messages, etc. Accurate to a tenth of a percent, rounded down. This file is put in the designated NightOnline folder.
HISTORY OF VERSIONS:
CC- 1.0 -Had many bugs, causing crashes and system errors.
-Used a text-only interface, where the user would be requested to type in the
pathnames accuractely (without any referece to anything), or else a bomb would
inevitably occur.
-Cleared the Callerlog file at the specified time.
CC- 2.0 -Fixed up bugs of version 1.0.
-Less or no system errors or crashes.
-Used Graphics-only interface with dialog boxes.
CC- 3.0 -Added date to Callerlog file.
-Option of having a backup sequential single Callerlog file as well.
-Option of having a backup of each day to a single file that was time stamped in its
name.
NO- 0.1 -Automatic re-configuration of the NOConfig file without pressing mouse button.
-Auto-sensing of the Version number, to eliminate most bombs if you upgrade.
-Cursor is fixed to an arrow, instead of having the Watch.
-Has a printer option of printing the Callerlog to an ImageWriter printer every day.
-Compiles the number of calls per modem speed, uploads, downloads, text reads,
messages, etc. in a separate daily file.
NO- 0.2 -Fixed up header version bug.
-Added a Top Statistics file that keeps track of highest number of calls, private
messages, public messages, uploads and downloads.
NO- 0.3 -Implemented UU's utilities including:
TopUploader List
Leech List
UserStatistics
NO- 0.4 -Fixed formatting of TopUploader list, Leech list, and UserStatistics list.
-Added option of having the callers for that day ONLY, to be listed in the PreviousStats
file.
-Fixed header date bug in MainCallerlog file.
-Appended date to "CALLERS" line in PreviousStats file.
-Added "Trashcan" feature.
-Up to 20 search keys.
-Up to 20 exception names.
-Automatic Mark for deletion.
-Automatic change of password (optional) to a desired word.
-Appendage to "TrashedUsers" file the names of the users that were trashed.
NO- 0.5 -Rewrite of NightOnline.
-Full Menu implementation.
-Supports Desk Accessories.
-Has auto-configuration for new versions/missing configuration file using pre-set
defaults.
-Menu selection of multiple options (ie. Check-marked menu items).
NO- 0.5a-Auto configuration reader and converter for versions 0.3 and on.
-Fixed version name bug in About box.
NO- 0.6 -Added UserPercent file that is regularily compiled.
-Fixed the Leech Ratio to have a grace of LeechExtra downloads before any more can be
downloaded. The formula used is:
if (DL > LeechExtra) and (DL/(UL+0.1) > Leech Ratio Number) then ...
NB: The '+0.1' is used to avoid problems with division by zero.
-Created status line. The status line on the right end on the menu bar shows what
its currently doing. Also useful if there is a bomb, as you can tell when the bomb
occured, and I have a better chance of figuring out why.
-Fixed bug in reading of Config file.
-Fixed bug in naming of Main Backup Callerlog file.
NO- 1.0 -Fixed formatting of problem names.
-Changed length of time that NO will wait for you to press the mouse (approx. 5 sec.)
-Allowed user to change the Leech Extra number.
-Appended Leech Extra number to end of Leech list.
-Made quitting without configuring almost fool-proof. Makes sure that user has
selected all of the 'Main' options.
-Added totals to the top of the User Percent list.
-Created Global New File list (alphabeticized). <-- Took forever to program.
-Removed version name from Apple Menu. Previously had wrong version number.
-Fixed the credit screen to something more decent.
-Created Most Frequent Downloaded software list.
-Created backup of Userlog file.
-Deleted users marked for deletion.
-Fixed bug that didn't save "checked" changes in menu selection from default.
-Eliminated wait if wrong or missing configuration (NOConfig) file.
-Added menu option to quit to BBS/NetMail Application or Finder.
-Padded some dates with zeros instead of spaces or nothing at all.
-Allowed Callerlog, BBS, NightOnline and Userlog files to be in different directories.
NB: Because of the many improvements and new features, I have changed
version 0.7 to 1.0.
NO- 1.01 -Allowed escape to finder without saving, in case you can't locate one of the files.
-Fixed bug that would crash computer if no Frequent list was comiled.
-Changed order of text file compilation. Created user statistics, Top Uplaoders, Leech
lists, etc. AFTER the users have been deleted from the Backup Userlog feature.
NO- 1.1-Added option to delete inactive users after a specified non-activity time.
-Fixed bug that would not update the selection choice, "Caller's Names & Stats".
-Put the User totals at the bottom of the User Percent list, under the appropriate
columns.
-Removed all failed log-on attempts that resulted in a "Logged off on..." line in the list
of callers' names.
-Failed log-on attempts are now not added to the number of calls.
-Changed spacing between the end of the list of callers and the statistics. (Aesthetic)
NO- 1.2-Fixed option, "Quit without saving".
-Fixed setting of number of permitted D/Ls before ratio is enabled.
-Removed all "Modem lost..." from the list of callers, and didn't count it as a call.
-Added Error Log.
NO- 1.3-Added feature that allows NightOnline's files to be put into a unique folder for
NightOnline's files.
NO- 1.4-Corrected Creator and Type of backup Userlog file.
-Fixed major bug that would cause 1.3 to crash when it came to the Top Uploaders list
compilation.
-Added Dates feature.
NO- 1.4Bx-Several Beta Versions
NO- 1.5-First relatively bug-free version since 1.1.
-Eliminated bug that would change the pathname to a file when you just went to the
dialog box for it. It would "double" the pathname, causing a crash.
-Fixed bug that made it impossible to select ten file sections, then redo them, as it
would not reset the number correctly and would cause an error as the number of
file sections would be greater than the allowed limit.
-Gave option to backup Userlog daily or not.
-Fixed several bugs related to the reading of the Global file sections.
-Corrected MenuHandle bug in status line at top right of screen that caused a bug.
NO- 1.51-Corrected bug that would crash during the sorting of the Frequent DL list if there
were more than (100-x) [x being the number of files to be listed] files in the
combined file sections.
-Fixed Error Log bug that would look for errors listed in the Callerlog file that begin
with a "##". It now looks for a beginning of "**", which is the proper starting of
an error line in the Callerlog file.
NO- 1.52-Eliminated many routes to a bomb.
NB: If you used 1.51 previously, erase the NOConfig file, as 1.51 corrupted it.
NO- 1.53-Fixed the nasty "13th" bug that would change any user with the day last called being
a 13 to a 32 (which obviously doesn't exist).
NO- 1.6-Fixed global bug.
-Reworked the global procedure so that it would compile a list of files for each section
with it's own user-inputted header, in order of time/date uploaded.
-Sped up compilation of the global list.
I have been working quite hard on this program to rule out mostly all of the bugs, and so I can quite honestly say that there are not many at this stage..
IF YOU HAVE ANY SUGGESTIONS, PLEASE FEEL FREE TO LET ME KNOW AND I'LL DO MY BEST TO IMPLEMENT THEM INTO THE NEXT VERSION.
WHAT IS MY GOAL?
My goal in this program is to create software that will automate as fully as possible some of the tasks to improve a BBS and make it more versatile.
FUTURE VERSIONS
I am not exactly sure what I will put into the future versions, but with your ideas, I should be able to have more and more features that will hopefully improve NightOnline as a reasonable utility for Red Ryder Host/Second Sight Host BBS's. Some have suggested that I write a NetMail application to run along with NightOnline. This, if I were to write it, would be nice, but would take vast amounts of time to program, and at this stage, I'm not up to it. Also, a suggestion for telling a user that calls via their modem to the BBS while NightOnline is running that "BBS maintenance is in progress, please call back later". This, I could try, but would also mean a lot of work to get the Communications working properly. A final feature would be a built-in language that you can write for NO to read and work with. For example, you could write, "INCREASE UPLOADS (JOHN SMITH) - 3" which would add two extra uploads to John Smith.
***SHAREWARE NOTICE***
I have decided as because of my efforts and time into this program to make this program ShareWare. A donation of $5 would be greatly appreciated, as I have spent many, many hours of work on this program. The $5 would also include (if you would find it useful) the full source code of NightOnline via whatever way you feel to be best.
You may give this utility to anybody else that might find it useful. I'd really enjoy hearing from you if you do find it useful, or have some suggestions. You can leave me mail at:
Apples BC BBS (604) 525-3089 David Martyn
Deep Cove/Doppler BBS (604) 277-9920 Wayne Duval
BC Macintosh BBS (604) 465-0017 Scott Leaf
MacLink BBS (604) 594-2446 Ben Lewit
Sunshine BBS (604) 943-1612 Bob Cotter
SOURCE CODE
I wrote this program completely in THINK's Lightspeed Pascal V2.01 and using ResEdit to create the resource file. If you would like the complete source code, just leave me a message at one of the above BBS's. The source code is approxiamately four thousand, two hundred lines long, not including the resource file. If you can give me any advice, or would like to talk to someone else that is just learning to program, then please feel free to leave me mail.
Calvin Hass
4296 W8th Ave.
Vancouver, B.C.
V6R-1Z9
...Or give me a call at (604) 224-6529 if it is local for you.
Thanks to (???) the person that created the original database of events and birthdays, for his long hours spent in compiling it. Originally created on the IBM, and readable by NightOnline on the Macintosh. Part of a package for the IBM labelled, "today.???".
Thanks to the many SysOps that have spent much of their time testing and setting up the new releases of NightOnline. I really appreciate it. And I'm sorry for some of the crashes that were dominant in the early versions.
